1   /**
2    * Copyright (C) 2006-2019 INRIA and contributors
3    *
4    * Spoon is available either under the terms of the MIT License (see LICENSE-MIT.txt) of the Cecill-C License (see LICENSE-CECILL-C.txt). You as the user are entitled to choose the terms under which to adopt Spoon.
5    */
6   package spoon.reflect.declaration;
7   
8   import spoon.reflect.reference.CtTypeReference;
9   import spoon.reflect.annotations.PropertyGetter;
10  import spoon.reflect.annotations.PropertySetter;
11  import spoon.support.UnsettableProperty;
12  
13  import java.util.List;
14  
15  import static spoon.reflect.path.CtRole.VALUE;
16  
17  /**
18   * This element represents an enumeration declaration.
19   *
20   * Example:
21   * <pre>
22   *    enum Boolean { TRUE, FALSE }
23   * </pre>
24  
25   */
26  public interface CtEnum<T extends Enum<?>> extends CtClass<T> {
27  	/**
28  	 * Adds an enum value.
29  	 *
30  	 * @param enumValue
31  	 * 		An enum value.
32  	 * @return <tt>true</tt> if this element changed as a result of the call
33  	 */
34  	@PropertySetter(role = VALUE)
35  	<C extends CtEnum<T>> C addEnumValue(CtEnumValue<?> enumValue);
36  
37  	/**
38  	 * Removes en enum value.
39  	 *
40  	 * @param enumValue
41  	 * 		An enum value.
42  	 * @return <tt>true</tt> if this element changed as a result of the call
43  	 */
44  	@PropertySetter(role = VALUE)
45  	boolean removeEnumValue(CtEnumValue<?> enumValue);
46  
47  	/**
48  	 * Gets an enum value by its name.
49  	 *
50  	 * @param name
51  	 * 		Name of the enum value.
52  	 * @return An enum value.
53  	 */
54  	@PropertyGetter(role = VALUE)
55  	CtEnumValue<?> getEnumValue(String name);
56  
57  	/**
58  	 * Gets all enum values of the enumeration.
59  	 *
60  	 * @return All enum values.
61  	 */
62  	@PropertyGetter(role = VALUE)
63  	List<CtEnumValue<?>> getEnumValues();
64  
65  	/**
66  	 *Sets all enum values of the enum.
67  	 */
68  	@PropertySetter(role = VALUE)
69  	<C extends CtEnum<T>> C setEnumValues(List<CtEnumValue<?>> enumValues);
70  
71  	@Override
72  	CtEnum<T> clone();
73  
74  	@Override
75  	@UnsettableProperty
76  	<T extends CtFormalTypeDeclarer> T setFormalCtTypeParameters(List<CtTypeParameter> formalTypeParameters);
77  
78  	@Override
79  	@UnsettableProperty
80  	<C extends CtType<T>> C setSuperclass(CtTypeReference<?> superClass);
81  }